<!DOCTYPE html>
<html>
<head>
  <title>Research software development</title>

  <link rel="stylesheet" href="/rsd/assets/css/main.css">
  <link rel="shortcut icon" type="image/png" href="/rsd/assets/favicon.ico"/>

  <link rel="stylesheet"
        href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css">
  <script
src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  <script>hljs.initHighlightingOnLoad();</script>

   
<style media="screen" type="text/css">


div.input_prompt {
  color: #303F9F;
}

div.output_prompt {
  color: #D84315;
}
</style>

    <!-- Loading mathjax macro -->
    <!-- Load mathjax -->
        <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>
        <!-- MathJax configuration -->
        <script type="text/x-mathjax-config">
        MathJax.Hub.Config({
            tex2jax: {
                inlineMath: [ ['$','$'], ["\\(","\\)"] ],
                displayMath: [ ['$$','$$'], ["\\[","\\]"] ],
                processEscapes: true,
                processEnvironments: true
            },
            // Center justify equations in code and markdown cells. Elsewhere
            // we use CSS to left justify single line equations in code cells.
            displayAlign: 'center',
            "HTML-CSS": {
                styles: {'.MathJax_Display': {"margin": 0}},
                linebreaks: { automatic: true }
            }
        });
        </script>
        <!-- End of mathjax configuration --></head>


    <!-- Google Analytics -->
    <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

    ga('create', 'UA-38016329-2', 'auto');
    ga('send', 'pageview');
    </script>

</head>
<body>

    <header class="site-header">

  <div class="wrap">


    <nav class="site-nav">
      <a href="#" class="menu-icon">
        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
           viewBox="0 0 18 15" enable-background="new 0 0 18 15" xml:space="preserve">
          <path fill="#505050" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0
            h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
          <path fill="#505050" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484
            h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
          <path fill="#505050" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0
            c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
        </svg>
      </a>
      <div class="trigger">
          <a class="page-link" href="/rsd/">RSD</a>
          <a class="page-link" href="/rsd/chapters/">Chapters</a>
          <a class="page-link" href="/rsd/extras/">Extras</a>
      </div>
    </nav>

  </div>
</header>

 <div class="page-content">
    <div class="wrap">
      <div class="home">
        
    <h1>Markdown</h1>
<p>Markdown is a:</p>
<blockquote>
<p>Markdown is a lightweight markup language with plain text formatting syntax. </p>
</blockquote>
<p>Markdown is a simple set of conventions for how to write text in plain text.
It is designed to ensure that it can be straightforwardly converted to html and
also easy to read in plain text.</p>
<p>A lot of descriptive files in software are written in markdown. For example most
repositories have a <code>README.md</code> which explains what the repository is for.
Github automatically renders these.</p>
<p>There are a number of great guides for markdown:</p>
<ul>
<li><a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet</a></li>
<li><a href="https://help.github.com/articles/basic-writing-and-formatting-syntax/">help.github.com/articles/basic-writing-and-formatting-syntax/</a></li>
<li><a href="https://daringfireball.net/projects/markdown/syntax">daringfireball.net/projects/markdown/syntax</a></li>
</ul>
<p>Here is some basic syntax:</p>
<h2>Headers and titles</h2>
<p>Use <code>#</code> to denote headers of various levels:</p>
<pre><code class="markdown">
# This is the title

## This is a section at the next level

### This is a section at the next next level

</code></pre>

<h2>Text formatting</h2>
<p>You can create bold and italicized text:</p>
<pre><code class="markdown">Here is some text, this word is **bold** and this word is *italicized*.
</code></pre>

<h2>Lists</h2>
<p>To create an enumerated list:</p>
<pre><code class="markdown">1. Here is a list
2. The order does matter
3. So I use numbers
</code></pre>

<p>To create an itemized list:</p>
<pre><code class="markdown">- Here is a list
- The order does not matter
- So I just use dashes
</code></pre>

<h2>Hyperlinks</h2>
<p>Here is how to create a hyperlink:</p>
<pre><code class="markdown">Here is the [course site for the rsd workshop](https://vknight.org/rsd/).
</code></pre>

<h2>Including code</h2>
<p>You can include inline code:</p>
<pre><code>Here is how to print hello world in python `print(&quot;hello world&quot;)`.
</code></pre>

<p>You can also include a big block of displayed code, by writing an indented
block:</p>
<pre><code>This is how to print hello world in python:

    print(&quot;hello world&quot;)
</code></pre>

<h2>Rendering markdown</h2>
<p>To view your markdown as html:</p>
<ul>
<li>View your markdown file on github (it automatically renders markdown).</li>
<li>Use code to render markdown (for example python has a library that will read
  markdown and write html).</li>
<li>Use your editors: many editors have plugins to view rendered markdown.</li>
<li>Don't :) Markdown is designed to be consistent and easy to read so for some
  things you might not need to render it at all.</li>
</ul>

      </div>
  </div>
</div>


</body>
</html>